IntelliJ Platform Gradle Plugin/org.jetbrains.intellij.platform.gradle.tasks/CustomTestIdeTask

CustomTestIdeTask

@UntrackedTask(because = "Should always run")
abstract class CustomTestIdeTask : Test, TestableAware, CustomIntelliJPlatformVersionAware

Runs plugin tests against the currently selected IntelliJ Platform with the built plugin loaded. It directly extends the Test Gradle task, which allows for an extensive configuration (system properties, memory management, etc.).

This task class also inherits from CustomIntelliJPlatformVersionAware, which makes it possible to create testIde-like tasks using custom IntelliJ Platform versions:

import org.jetbrains.intellij.platform.gradle.IntelliJPlatformType
import org.jetbrains.intellij.platform.gradle.tasks.CustomTestIdeTask

tasks {
  val testPhpStorm by registering(CustomTestIdeTask::class) {
    type = IntelliJPlatformType.PhpStorm
    version = "2023.2.2"
  }

  val testLocalIde by registering(CustomTestIdeTask::class) {
    localPath = file("/Users/hsz/Applications/Android Studio.app")
  }
}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion : Registrable

Properties

Link copied to clipboard
@get:OutputDirectory
val binaryResultsDirectory: DirectoryProperty
Link copied to clipboard
@get:Internal(value = "captured by stableClasspath")
var classpath: FileCollection
Link copied to clipboard
@get:Internal
val conventionMapping: ConventionMapping
Link copied to clipboard
@get:Internal
@get:Optional
abstract val coroutinesJavaAgentFile: RegularFileProperty

The path to the coroutines Java Agent file.

Link copied to clipboard
@get:Internal
var enabled: Boolean
Link copied to clipboard
Link copied to clipboard
@get:Internal
var forkEvery: Long
Link copied to clipboard
@get:Internal
open val frontendPropertiesFile: Provider<RegularFile>

Path to a properties file which will be used to configure the frontend process if the IDE is started in Split Mode.

Link copied to clipboard
Link copied to clipboard
@get:Internal
var ignoreFailures: Boolean
Link copied to clipboard
Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformPluginConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_PLUGIN_DEPENDENCY configuration with the optional custom IntelliJ Platform plugins dependencies added. It should not be directly accessed.

Link copied to clipboard
val javaLauncher: Property<JavaLauncher>
Link copied to clipboard
@get:InputDirectory
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:Optional
abstract val localPath: DirectoryProperty

An input property to define the path to the local IntelliJ Platform instance to configure the version of the custom IntelliJ Platform.

Link copied to clipboard
@get:Internal
var maxParallelForks: Int
Link copied to clipboard
val modularity: ModularitySpec
Link copied to clipboard
@get:Internal
open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

Link copied to clipboard
@get:InputFile
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:Optional
abstract val pluginXml: RegularFileProperty

Holds the path to the patched plugin.xml file.

Link copied to clipboard
@get:Internal
open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

Link copied to clipboard
val reports: TestTaskReports
Link copied to clipboard
@get:Internal
abstract val runtimeArchitecture: Property<String>

An architecture of the Java Runtime currently used for running Gradle.

Link copied to clipboard
@get:InputDirectory
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val runtimeDirectory: DirectoryProperty

Java Runtime parent directory.

Link copied to clipboard
@get:Internal
abstract val runtimeLauncher: Property<JavaLauncher>

A custom JavaLauncher instance configured with the resolved runtimeDirectory.

Link copied to clipboard
@get:Internal
abstract val runtimeMetadata: MapProperty<String, String>

Metadata object of the Java Runtime currently used for running Gradle.

Link copied to clipboard
@get:Internal
abstract val sandboxConfigDirectory: DirectoryProperty

A configuration directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxContainerDirectory: DirectoryProperty

The container for all sandbox-related directories. The directory name depends on the platform type and version currently used for running a task.

Link copied to clipboard
@get:Internal
abstract val sandboxLogDirectory: DirectoryProperty

A log directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxPluginsDirectory: DirectoryProperty

A plugins directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxSuffix: Property<String>

Represents the suffix used i.e., for test-related tasks.

Link copied to clipboard
@get:Internal
abstract val sandboxSystemDirectory: DirectoryProperty

A system directory located within the sandboxContainerDirectory.

Link copied to clipboard
@get:Input
var scanForTestClasses: Boolean
Link copied to clipboard
val state: TaskStateInternal
Link copied to clipboard
@get:Internal
var testClassesDirs: FileCollection
Link copied to clipboard
@get:Internal
val testLogging: TestLoggingContainer
Link copied to clipboard
val timeout: Property<Duration>
Link copied to clipboard
@get:Input
@get:Optional
abstract val type: Property<IntelliJPlatformType>

An input property to configure the type of the custom IntelliJ Platform.

Link copied to clipboard
@get:Input
@get:Optional
abstract val version: Property<String>

An input property to configure the version of the custom IntelliJ Platform.

Functions

Link copied to clipboard
open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)
Link copied to clipboard
open fun addTestListener(p0: TestListener)
Link copied to clipboard
open fun addTestOutputListener(p0: TestOutputListener)
Link copied to clipboard
open fun afterSuite(p0: Closure<Any>)
Link copied to clipboard
open fun afterTest(p0: Closure<Any>)
Link copied to clipboard
open override fun appendParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun beforeSuite(p0: Closure<Any>)
Link copied to clipboard
open fun beforeTest(p0: Closure<Any>)
Link copied to clipboard
open override fun bootstrapClasspath(vararg classpath: Any): Test
Link copied to clipboard
open operator override fun compareTo(other: Task): Int
Link copied to clipboard
open override fun configure(closure: Closure<Any>): Task
Link copied to clipboard
open fun conventionMapping(property: String, mapping: Closure<Any>): Task
open fun conventionMapping(property: String, mapping: Callable<*>): Task
Link copied to clipboard
open override fun copyTo(target: JavaForkOptions): Test
open override fun copyTo(target: ProcessForkOptions): Test
Link copied to clipboard
open override fun debugOptions(action: Action<JavaDebugOptions>)
Link copied to clipboard
open override fun dependsOn(vararg paths: Any): Task
Link copied to clipboard
open override fun doFirst(action: Closure<Any>): Task
open override fun doFirst(action: Action<in Task>): Task
open override fun doFirst(actionName: String, action: Action<in Task>): Task
Link copied to clipboard
open override fun doLast(action: Closure<Any>): Task
open override fun doLast(action: Action<in Task>): Task
open override fun doLast(actionName: String, action: Action<in Task>): Task
Link copied to clipboard
open override fun doNotTrackState(reasonNotToTrackState: String)
Link copied to clipboard
open override fun environment(environmentVariables: MutableMap<String, *>): Test
open override fun environment(name: String, value: Any): Test
Link copied to clipboard
open override fun exclude(excludeSpec: Closure<Any>): Test
open override fun exclude(vararg excludes: String): Test
open override fun exclude(excludes: MutableIterable<String>): Test
open override fun exclude(excludeSpec: Spec<FileTreeElement>): Test
Link copied to clipboard
open override fun executable(executable: Any): Test
Link copied to clipboard
open override fun executeTests()
Link copied to clipboard
open fun filter(action: Action<TestFilter>)
Link copied to clipboard
open override fun finalizedBy(vararg paths: Any): Task
Link copied to clipboard
open override fun getActions(): MutableList<Action<in Task>>
Link copied to clipboard
open override fun getAllJvmArgs(): MutableList<String>
Link copied to clipboard
open override fun getAnt(): AntBuilder
Link copied to clipboard
@Internal
open override fun getAsDynamicObject(): DynamicObject
Link copied to clipboard
open override fun getBootstrapClasspath(): FileCollection
Link copied to clipboard
@InputFiles
@SkipWhenEmpty
@IgnoreEmptyDirectories
@PathSensitive(value = PathSensitivity.RELATIVE)
open fun getCandidateClassFiles(): FileTree
Link copied to clipboard
@Internal
open override fun getConvention(): Convention
Link copied to clipboard
open override fun getDebug(): Boolean
Link copied to clipboard
open override fun getDebugOptions(): JavaDebugOptions
Link copied to clipboard
open override fun getDefaultCharacterEncoding(): String?
Link copied to clipboard
open override fun getDependsOn(): MutableSet<Any>
Link copied to clipboard
open override fun getDescription(): String?
Link copied to clipboard
open override fun getDestroyables(): TaskDestroyables
Link copied to clipboard
open override fun getDidWork(): Boolean
Link copied to clipboard
@Incubating
@Input
abstract fun getDryRun(): Property<Boolean>
Link copied to clipboard
open override fun getEnableAssertions(): Boolean
Link copied to clipboard
@Internal
open override fun getEnvironment(): MutableMap<String, Any>
Link copied to clipboard
@Internal
open override fun getExcludes(): MutableSet<String>
Link copied to clipboard
@Internal
open override fun getExecutable(): String
Link copied to clipboard
open override fun getExtensions(): ExtensionContainer
Link copied to clipboard
open fun getFilter(): TestFilter
Link copied to clipboard
open override fun getFinalizedBy(): TaskDependency
Link copied to clipboard
open override fun getGroup(): String?
Link copied to clipboard
open override fun getIdentityPath(): Path
Link copied to clipboard
@Internal
open override fun getIncludes(): MutableSet<String>
Link copied to clipboard
open override fun getInputs(): TaskInputsInternal
Link copied to clipboard
@Input
open fun getJavaVersion(): JavaVersion
Link copied to clipboard
open override fun getJvmArgs(): MutableList<String>?
Link copied to clipboard
open override fun getJvmArgumentProviders(): MutableList<CommandLineArgumentProvider>
Link copied to clipboard
@Internal
open override fun getLifecycleDependencies(): TaskDependencyInternal
Link copied to clipboard
open override fun getLocalState(): TaskLocalState
Link copied to clipboard
open override fun getLogger(): Logger
Link copied to clipboard
open override fun getLogging(): LoggingManager
Link copied to clipboard
open override fun getMaxHeapSize(): String?
Link copied to clipboard
open override fun getMinHeapSize(): String?
Link copied to clipboard
open override fun getMustRunAfter(): TaskDependency
Link copied to clipboard
open override fun getName(): String
Link copied to clipboard
open override fun getOnlyIf(): Spec<in TaskInternal>
Link copied to clipboard
open fun getOptions(): TestFrameworkOptions
Link copied to clipboard
open override fun getOutputs(): TaskOutputsInternal
Link copied to clipboard
open override fun getPath(): String
Link copied to clipboard
open override fun getProject(): Project
Link copied to clipboard
open override fun getReasonNotToTrackState(): Optional<String>
Link copied to clipboard
open override fun getRequiredServices(): TaskRequiredServices
Link copied to clipboard
open override fun getSharedResources(): MutableList<ResourceLock>
Link copied to clipboard
open override fun getShouldRunAfter(): TaskDependency
Link copied to clipboard
open override fun getStandardOutputCapture(): StandardOutputCapture
Link copied to clipboard
open override fun getSystemProperties(): MutableMap<String, Any>
Link copied to clipboard
open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>
Link copied to clipboard
open override fun getTaskDependencies(): TaskDependencyInternal
Link copied to clipboard
open override fun getTaskIdentity(): TaskIdentity<*>
Link copied to clipboard
open override fun getTemporaryDir(): File
Link copied to clipboard
open override fun getTemporaryDirFactory(): Factory<File>
Link copied to clipboard
@Internal
open fun getTestFramework(): TestFramework
Link copied to clipboard
open fun getTestFrameworkProperty(): Property<TestFramework>
Link copied to clipboard
@Internal
open override fun getWorkingDir(): File
Link copied to clipboard
open override fun hasProperty(propertyName: String): Boolean
Link copied to clipboard
open override fun hasTaskActions(): Boolean
Link copied to clipboard
open override fun include(includeSpec: Closure<Any>): Test
open override fun include(vararg includes: String): Test
open override fun include(includes: MutableIterable<String>): Test
open override fun include(includeSpec: Spec<FileTreeElement>): Test
Link copied to clipboard
Link copied to clipboard
open override fun jvmArgs(vararg arguments: Any): Test
open override fun jvmArgs(arguments: MutableIterable<*>): Test
Link copied to clipboard
open override fun mustRunAfter(vararg paths: Any): Task
Link copied to clipboard
open override fun notCompatibleWithConfigurationCache(reason: String)
Link copied to clipboard
open override fun onlyIf(onlyIfClosure: Closure<Any>)
open override fun onlyIf(spec: Spec<in Task>)
open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)
Link copied to clipboard
open fun onOutput(p0: Closure<Any>)
Link copied to clipboard
open fun options(@DelegatesTo(value = TestFrameworkOptions::class) testFrameworkConfigure: Closure<Any>): TestFrameworkOptions
open fun options(testFrameworkConfigure: Action<in TestFrameworkOptions>): TestFrameworkOptions
Link copied to clipboard
open fun ExtensionAware.plugins(configuration: Action<IntelliJPlatformPluginsExtension>)

Adds plugins to the custom IntelliJ Platform using the specified configuration.

Link copied to clipboard
open override fun prependParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open override fun property(propertyName: String): Any?
Link copied to clipboard
open fun removeTestListener(p0: TestListener)
Link copied to clipboard
open fun removeTestOutputListener(p0: TestOutputListener)
Link copied to clipboard
open override fun reports(p0: Closure<Any>): TestTaskReports
open override fun reports(p0: Action<in TestTaskReports>): TestTaskReports
Link copied to clipboard
open override fun setActions(replacements: MutableList<Action<in Task>>)
Link copied to clipboard
open override fun setAllJvmArgs(arguments: MutableIterable<*>)
open override fun setAllJvmArgs(arguments: MutableList<String>)
Link copied to clipboard
open override fun setBootstrapClasspath(classpath: FileCollection)
Link copied to clipboard
open override fun setDebug(enabled: Boolean)
Link copied to clipboard
open override fun setDefaultCharacterEncoding(defaultCharacterEncoding: String?)
Link copied to clipboard
open override fun setDependsOn(dependsOn: MutableIterable<*>)
Link copied to clipboard
open override fun setDescription(description: String?)
Link copied to clipboard
open override fun setDidWork(didWork: Boolean)
Link copied to clipboard
open override fun setEnableAssertions(enabled: Boolean)
Link copied to clipboard
open override fun setEnvironment(environmentVariables: MutableMap<String, *>)
Link copied to clipboard
open override fun setExcludes(excludes: MutableIterable<String>): Test
Link copied to clipboard
open override fun setExecutable(executable: Any)
open override fun setExecutable(executable: String)
Link copied to clipboard
open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)
Link copied to clipboard
open fun setForkEvery(@Nullable forkEvery: Long?)
Link copied to clipboard
open override fun setGroup(group: String?)
Link copied to clipboard
open override fun setIncludes(includes: MutableIterable<String>): Test
Link copied to clipboard
open override fun setJvmArgs(arguments: MutableIterable<*>?)
open override fun setJvmArgs(arguments: MutableList<String>?)
Link copied to clipboard
open override fun setMaxHeapSize(heapSize: String?)
Link copied to clipboard
open override fun setMinHeapSize(heapSize: String?)
Link copied to clipboard
open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)
Link copied to clipboard
open override fun setOnlyIf(onlyIfClosure: Closure<Any>)
open override fun setOnlyIf(spec: Spec<in Task>)
open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)
Link copied to clipboard
open override fun setProperty(name: String, value: Any)
Link copied to clipboard
open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)
Link copied to clipboard
open override fun setSystemProperties(properties: MutableMap<String, *>)
Link copied to clipboard
open override fun setTestNameIncludePatterns(testNamePattern: MutableList<String>): Test
Link copied to clipboard
open override fun setWorkingDir(dir: File)
open override fun setWorkingDir(dir: Any)
Link copied to clipboard
open override fun shouldRunAfter(vararg paths: Any): TaskDependency
Link copied to clipboard
open override fun systemProperties(properties: MutableMap<String, *>): Test
Link copied to clipboard
open override fun systemProperty(name: String, value: Any): Test
Link copied to clipboard
open fun testFramework(@Nullable testFrameworkConfigure: Closure<Any>?): TestFramework
Link copied to clipboard
open fun testLogging(@DelegatesTo(value = TestLoggingContainer::class) p0: Closure<Any>)
open fun testLogging(p0: Action<in TestLoggingContainer>)
Link copied to clipboard
open fun useJUnit()
open fun useJUnit(@Nullable @DelegatesTo(value = JUnitOptions::class) testFrameworkConfigure: Closure<Any>?)
open fun useJUnit(testFrameworkConfigure: Action<in JUnitOptions>)
Link copied to clipboard
open fun useJUnitPlatform()
open fun useJUnitPlatform(testFrameworkConfigure: Action<in JUnitPlatformOptions>)
Link copied to clipboard
open override fun usesService(service: Provider<out BuildService<*>>)
Link copied to clipboard
open fun useTestNG()
open fun useTestNG(@DelegatesTo(value = TestNGOptions::class) testFrameworkConfigure: Closure<Any>)
open fun useTestNG(testFrameworkConfigure: Action<in TestNGOptions>)
Link copied to clipboard
open fun validateIntelliJPlatformVersion()

Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.

Link copied to clipboard
open override fun workingDir(dir: Any): Test